Get a timestream

GET 
/timestreams/:timestreamId

Gets full details of a specific timestream

Request

Path Parameters

timestreamId stringrequired

The id of the timestream

Header Parameters

x-api-key passwordrequired

OneBasket API Key

Responses

200

The request has succeeded.

application/json

Schema

Schema

type stringrequired

Possible values: [TicketedEvent]

The type of the timestream

TicketedEvent

circular(Timestreams.TicketedEventTimestreamDto)

id stringrequired

The unique identifier of the timestream

title stringrequired

The title of the timestream

description stringrequired

The description of the timestream

venue stringrequired

The venue selected for the timestream

timelines objectrequired
The timelines of the timestream
property name* integer
type stringrequired

Possible values: [TicketedEvent]

ticketedEvent object
venueName stringrequired

The name of the venue

competitionName stringrequired

The name of the competation

date date-timerequired

The date of the event

logoUrl stringrequired

The logo of the event

competitionLogoUrl stringrequired

The logo of the competition

Example (from schema)

{
  "type": "TicketedEvent",
  "ticketedEvent": "string",
  "venueName": "string",
  "competitionName": "string",
  "date": "2024-01-11T21:22:38.995Z",
  "logoUrl": "string",
  "competitionLogoUrl": "string",
  "id": "string",
  "title": "string",
  "description": "string",
  "venue": "string",
  "timelines": {}
}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Bad request]

A short, human-readable summary of the problem type.

status number

Possible values: [400]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

errors objectrequired
property name* object

Example (from schema)

{
  "type": "string",
  "title": "Bad request",
  "status": 400,
  "detail": "string",
  "instance": "string",
  "errors": {}
}

401

Access is unauthorized.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Unauthorized]

A short, human-readable summary of the problem type.

status number

Possible values: [401]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Unauthorized",
  "status": 401,
  "detail": "string",
  "instance": "string"
}

404

The server cannot find the requested resource.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Not Found]

A short, human-readable summary of the problem type.

status number

Possible values: [404]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Not Found",
  "status": 404,
  "detail": "string",
  "instance": "string"
}

Loading...